Request

curl --location 'https://openapi.gs-robot.com/openapi/v3/schedules/plans/get' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{token}}' \
--data '{
  "dayOfMonth": 1,
  "month": 1,
  "planUuid": "plan-demo-001",
  "robotSn": "DEMO00-0000-000-B001",
  "year": 2024
}'

Version requirement: This API is supported only on AIO software version 1.6 and later.

Response

{
  "code": 0,
  "data": {
    "missionStatus": 0,
    "planCommitNo": "1",
    "planExecuteType": "QUANTITATIVE_SCH_TASK",
    "planFusionTaskExternal": {
      "fusionTaskId": "00000000-0000-4000-8000-000000000001",
      "fusionTaskType": 1,
      "mapList": [
        {
          "floorIndex": 0,
          "floorName": "",
          "mapId": "00000000-0000-4000-8000-000000000002",
          "mapName": "Example map",
          "mapResourceList": [
            {
              "mapResourceAreaId": "1",
              "mapResourceId": "00000000-0000-4000-8000-000000000003",
              "mapResourceName": "example-area",
              "mapResourceType": "region"
            }
          ]
        }
      ],
      "siteId": "",
      "siteName": "",
      "taskAPIVersion": ""
    },
    "planFusionTaskMain": {
      "createdAt": 1704067200,
      "fusionName": "Example schedule task",
      "fusionTaskId": "00000000-0000-4000-8000-000000000001",
      "fusionTaskType": 1,
      "loopCount": 1,
      "persistence": true,
      "siteInfo": {
        "siteId": ""
      },
      "taskAPIVersion": "",
      "taskAdvanceConfig": {
        "autoPlanning": true,
        "coverageMode": "standard",
        "tempTaskPriority": false
      },
      "tasks": [
        {
          "id": "00000000-0000-4000-8000-000000000004",
          "mapId": "00000000-0000-4000-8000-000000000002",
          "mapResourceId": "00000000-0000-4000-8000-000000000003",
          "type": "region"
        }
      ],
      "updatedAt": 1704067200,
      "updatedUser": "demo-user",
      "user": "demo-user",
      "workMode": {
        "id": "00000000-0000-4000-8000-000000000005",
        "name": "sweep",
        "strength": "middle",
        "subType": "sweep",
        "type": 0
      }
    },
    "planRepeatType": 0,
    "planRepeatWeekly": [],
    "planStartDate": "2024-01-01",
    "planStartTime": "08:00",
    "planStopDate": "2024-01-01",
    "planStopTime": "09:00",
    "planUuid": "00000000-0000-4000-8000-000000000001",
    "robotAlias": "Example robot",
    "robotFamilyCode": "",
    "robotSn": "DEMO00-0000-000-B001",
    "semesterCommitNo": "5",
    "semesterType": 4,
    "semesterUuid": "semester-demo-001",
    "taskName": "Example schedule task"
  },
  "msg": "SUCCESS"
}